Improved cabin sizing documentation #101
Conversation
revived resizing tests updated cabin figure with better seats
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #101 +/- ##
==========================================
- Coverage 73.41% 73.20% -0.22%
==========================================
Files 77 80 +3
Lines 13908 13500 -408
==========================================
- Hits 10211 9882 -329
+ Misses 3697 3618 -79 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
src/IO/read_input.jl
Outdated
| @@ -142,8 +142,9 @@ if !ac_type_fixed | |||
| end | |||
|
|
|||
| maxpax = readmis("max_payload_in_pax_equivalent") #This represents the maximum aircraft payload in equivalent number of pax | |||
| #Part of this payload may be carried in the aircraft's cargo hold | |||
There was a problem hiding this comment.
do you mean to clarify that maxpax includes tonnage beyond passenger-associated weight?
If so, consider rephrasing something like, "this may exceed the seatable capacity to account for belly cargo."
tangential question, is this extra mass assumed to distribute uniformly along the cabin? if so, seems worth noting in the docs (if not already done).
There was a problem hiding this comment.
I didn't make changes to the way that the maximum payload is handled by fuseW(). My understanding is that it is indeed uniformly distributed.
docs/src/structures/cabin_sizing.md
Outdated
There was a problem hiding this comment.
A good detailed pass. Two suggestions:
- a very high level summary as the introductory paragraph would be ideal. Something that answers very quickly: "tasopt includes these assumptions by default, additional models can include y (e.g., doubledecking), you can calculate/optimize x if you specify blah".
- On a more nitpicky stylistic note, the gen'l structure for each documentation page is: 1. high level summary, 2. conceptual/theoretical breakdown with figures and/or references (with links) to the relevant fxns 3. list of fxns as a list at the end. adhering to this i think would be helpful in keeping things consistent for readers
There was a problem hiding this comment.
Thanks for the suggestion. I just made these changes.
| @@ -21,7 +22,7 @@ length. | |||
| function place_cabin_seats(pax, cabin_width, seat_pitch = 30.0*in_to_m, | |||
| seat_width = 19.0*in_to_m, aisle_halfwidth = 10.0*in_to_m, fuse_offset = 6.0*in_to_m) | |||
|
|
|||
| cabin_offset = 10 * ft_to_m #Distance to the front and back of seats | |||
| cabin_offset = 10 * ft_to_m #Distance to the front of seats | |||
| #TODO the hardcoded 10 ft is not elegant | |||
There was a problem hiding this comment.
agreed. off-the-cuff thought: perhaps it could be a default value for a field within the Cabin struct
|
Thanks for making the changes. Made a few more and i think we're good to go. |
This PR follows the request in PR #97 for better documentation on the cabin sizing models. A new page has been added to the
docssummarizing the modeling approach for the single and double decker aircraft. In addition, old tests of the resizing functions that were removed when changing the fuselage data storage have been brought back.